Retrieve Minimum Model Run Resolution for a GeoTIFF
Some models in the FMSF have limits on the size of the GeoTIFF that can be used. The limits are cell based rather than size based because GeoTIFFs do not have a set resolution. This call will return the number of cells and the minimum resolution (in multiples of 30) that each model can be run for the specified GeoTIFF.
|
Model |
Cell Limit |
|---|---|
|
FLAM (FlamMap) |
54,804,196 |
|
MTT_ (MTT) |
18,000,000 |
|
RNDG (RANDIG) |
3,000,000 |
|
FSPR (FSPro) |
2,500,000 |
|
FARS (FARSITE) |
54,804,196 |
|
FOFM (SpatialFOFEM Consumption and Emissions) |
N/A |
|
SFTM (SpatialFOFEM Tree Mortality) |
N/A |
API Endpoint
API Endpoint
GET /model/limits/<GeoTIFF ID>
Example Request
curl -X GET "https://fmsf.firenet.gov/fmsfModelREST/model/limits/<GeoTIFFID>" -H "accept: application/jspn" -H "Authorization: Basic <basic64 encoded username:API key>"
Example Response
{"landscapeId": <GeoTIFF ID>, "landscapeOwner": "<Username>", "landscapeCells": 246194, "landscapeDeleted": false, "minBasicResolution": 30, "minMTTResolution": 30, "minFARSITEResolution": 30, "minRANDIGResolution": 30, "minFSProResolution": 30}
Request Body
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
Authorization |
String |
Required |
<Basic64 encoded username:API key> credentials of the User |
|
GeoTIFF ID |
Integer |
Required |
<GeoTIFF ID> assigned to the GeoTIFF |
Response Fields
Code 200 - OK
|
Name |
Type |
Description |
|---|---|---|
|
landscapeId |
Integer |
FMSF assigned <GeoTIFF ID> for the uploaded GeoTIFF |
|
landscapeOwner |
string |
User who uploaded GeoTIFF |
|
landscapeCells |
Integer |
Number of cells within the GeoTIFF |
|
landscapeDeleted |
Boolean |
Whether or not the GeoTIFF is still available to use. If TRUE, it will need to be re-upload or re-created |
|
minBasicResolution |
Integer |
Minimum resolution of the GeoTIFF for a FlamMap model run |
|
minMTTResolution |
Integer |
Minimum resolution of the GeoTIFF for a MTT model run |
|
minFARSITEResolution |
Integer |
Minimum resolution of the GeoTIFF for a FARSITE model run |
|
minRANDIGResolution |
Integer |
Minimum resolution of the GeoTIFF for a RANDIG model run |
|
minFSProResolution |
Integer |
Minimum resolution of the GeoTIFF for a FSPro model run |
Code 400 – The request was unacceptable
Invalid <GeoTIFF ID> provided
Code 401 – Unauthorized
Authorization info is missing or invalid
Code 500 – Server errors
Something went wrong on the FMSF end. Server error handling the request